Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✅ Add link checker #2189

Merged
merged 8 commits into from
Mar 14, 2022
Merged

✅ Add link checker #2189

merged 8 commits into from
Mar 14, 2022

Conversation

CollierCZ
Copy link
Contributor

@CollierCZ CollierCZ commented Feb 22, 2022 •
edited by trolologuy
Loading

Why

We want to ensure all our links are still valid.
Closes #2049

What's changed

  • Added muffet as a link checker to crawl and check links.
    • It needs to be rate limited for sites like GitHub, which means it takes a while.
    • It's also flaky, especially with Community sometimes timing out for no reason.
  • So moved it to a twice-weekly check that will update 🐛 Broken links #2213 with any broken links found.
  • Added an internal link checker to test each PR that's submitted.
    • Vault is excluded because it uses headings from transclusion (so they're marked as missing). If there's a problem, it should be caught in the regular check.
  • Fixed links identified by both checks.
  • Added checks to CONTRIBUTING.md

@CollierCZ CollierCZ added the WIP label Feb 22, 2022
@CollierCZ CollierCZ self-assigned this Feb 22, 2022
@CollierCZ CollierCZ closed this Feb 22, 2022
@CollierCZ CollierCZ reopened this Feb 22, 2022
@CollierCZ CollierCZ closed this Feb 22, 2022
@CollierCZ CollierCZ reopened this Feb 22, 2022
@CollierCZ CollierCZ closed this Feb 22, 2022
@CollierCZ CollierCZ reopened this Feb 22, 2022
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 2 times, most recently from d513a91 to ccfd02d Compare February 23, 2022 15:57
@platformsh platformsh deleted a comment from github-actions bot Feb 24, 2022
@platformsh platformsh deleted a comment from github-actions bot Feb 24, 2022
@platformsh platformsh deleted a comment from github-actions bot Feb 24, 2022
@platformsh platformsh deleted a comment from github-actions bot Feb 24, 2022
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 7 times, most recently from 8f1238c to bac9c1e Compare February 24, 2022 16:19
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 2 times, most recently from 15e9b28 to c272fe1 Compare March 1, 2022 15:30
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 3 times, most recently from a932ab6 to 8f104f9 Compare March 1, 2022 17:18
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 3 times, most recently from 896990e to 85dbc2c Compare March 2, 2022 14:19
@CollierCZ CollierCZ force-pushed the add-linkcheck branch 2 times, most recently from e078472 to 8476cb5 Compare March 2, 2022 16:13
@CollierCZ
🐛 Fix links
1a34b2b 
Including non-standard syntax that hurt parsers
@CollierCZ CollierCZ requested a review from trolologuy March 2, 2022 16:22
@CollierCZ CollierCZ removed the WIP label Mar 2, 2022
@CollierCZ CollierCZ removed the request for review from trolologuy March 2, 2022 16:23
@CollierCZ CollierCZ requested a review from trolologuy March 2, 2022 16:31
trolologuy
trolologuy previously approved these changes Mar 11, 2022
View reviewed changes
Copy link
Contributor

@trolologuy trolologuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! That's quite a massive PR. I can't wait to see the automatic link checker live!
A few proposed changes here and there, but nothing big either.

  • Final built pages are working as expected.
  • The information is correct.
  • The information is comprehensive.
  • The information is concise.
  • The information is clear.
  • All links work, including to section headers.

✅ Okey to merge.

.github/workflows/scheduled-check-links.yaml Outdated Show resolved Hide resolved
docs/layouts/shortcodes/clone-commit.md Outdated Show resolved Hide resolved
docs/layouts/shortcodes/guides/gatsby/headless-backend.html Show resolved Hide resolved
docs/src/configuration/services/vault.md Show resolved Hide resolved
docs/src/dedicated-gen-3/overview.md Outdated Show resolved Hide resolved
docs/src/development/troubleshoot.md Show resolved Hide resolved
docs/src/guides/drupal9/solr.md Show resolved Hide resolved
docs/src/guides/gatsby/headless/strapi.md Outdated Show resolved Hide resolved
docs/src/integrations/source/bitbucket.md Outdated Show resolved Hide resolved
docs/src/integrations/source/github.md Show resolved Hide resolved
@CollierCZ CollierCZ requested a review from trolologuy March 14, 2022 10:33
trolologuy
trolologuy approved these changes Mar 14, 2022
View reviewed changes
Copy link
Contributor

@trolologuy trolologuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, looks better now 🎉

@CollierCZ CollierCZ merged commit 1e6c28e into main Mar 14, 2022
@CollierCZ CollierCZ deleted the add-linkcheck branch March 14, 2022 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trolologuy trolologuy trolologuy approved these changes

Assignees

@CollierCZ CollierCZ

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

✨ Add an external link checker
2 participants
@CollierCZ @trolologuy